<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>py2ecotect.doc.calculation</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="py2ecotect-module.html">Package&nbsp;py2ecotect</a> ::
        <a href="py2ecotect.doc-module.html">Package&nbsp;doc</a> ::
        Module&nbsp;calculation
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="py2ecotect.doc.calculation-pysrc.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<h1 class="epydoc">Source Code for <a href="py2ecotect.doc.calculation-module.html">Module py2ecotect.doc.calculation</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno">  1</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt id="link-0" class="py-name" targets="Package py2ecotect=py2ecotect-module.html"><a title="py2ecotect" class="py-name" href="#" onclick="return doclink('link-0', 'py2ecotect', 'link-0');">py2ecotect</a></tt> <tt class="py-keyword">as</tt> <tt class="py-name">p2e</tt> </tt>
<a name="L2"></a><tt class="py-lineno">  2</tt>  <tt class="py-line"> </tt>
<a name="L3"></a><tt class="py-lineno">  3</tt>  <tt class="py-line"><tt class="py-comment">#===========================================================================</tt> </tt>
<a name="L4"></a><tt class="py-lineno">  4</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Functions</tt> </tt>
<a name="L5"></a><tt class="py-lineno">  5</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#===========================================================================</tt> </tt>
<a name="acoustic_response"></a><div id="acoustic_response-def"><a name="L6"></a><tt class="py-lineno">  6</tt> <a class="py-toggle" href="#" id="acoustic_response-toggle" onclick="return toggle('acoustic_response');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.calculation-module.html#acoustic_response">acoustic_response</a><tt class="py-op">(</tt><tt class="py-param">type</tt><tt class="py-op">,</tt> <tt class="py-param">frequency</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="acoustic_response-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="acoustic_response-expanded"><a name="L7"></a><tt class="py-lineno">  7</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L8"></a><tt class="py-lineno">  8</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L9"></a><tt class="py-lineno">  9</tt>  <tt class="py-line"><tt class="py-docstring">    Calculates the acoustic response based on acoustic rays already </tt> </tt>
<a name="L10"></a><tt class="py-lineno"> 10</tt>  <tt class="py-line"><tt class="py-docstring">    generated using the rays object. </tt> </tt>
<a name="L11"></a><tt class="py-lineno"> 11</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L12"></a><tt class="py-lineno"> 12</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L13"></a><tt class="py-lineno"> 13</tt>  <tt class="py-line"><tt class="py-docstring">    This command takes the following parameters.</tt> </tt>
<a name="L14"></a><tt class="py-lineno"> 14</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L15"></a><tt class="py-lineno"> 15</tt>  <tt class="py-line"><tt class="py-docstring">    type </tt> </tt>
<a name="L16"></a><tt class="py-lineno"> 16</tt>  <tt class="py-line"><tt class="py-docstring">    This parameter is either 0 for a 'Estimated Reverberation' calculation </tt> </tt>
<a name="L17"></a><tt class="py-lineno"> 17</tt>  <tt class="py-line"><tt class="py-docstring">    or 1 for a calculation based on 'Existing Rays/Particles'. </tt> </tt>
<a name="L18"></a><tt class="py-lineno"> 18</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L19"></a><tt class="py-lineno"> 19</tt>  <tt class="py-line"><tt class="py-docstring">    frequency </tt> </tt>
<a name="L20"></a><tt class="py-lineno"> 20</tt>  <tt class="py-line"><tt class="py-docstring">    The frequency parameter refers to the numeric values given in the </tt> </tt>
<a name="L21"></a><tt class="py-lineno"> 21</tt>  <tt class="py-line"><tt class="py-docstring">    following </tt> </tt>
<a name="L22"></a><tt class="py-lineno"> 22</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L23"></a><tt class="py-lineno"> 23</tt>  <tt class="py-line"><tt class="py-docstring">    Available Acoustic Frequencies table. </tt> </tt>
<a name="L24"></a><tt class="py-lineno"> 24</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L25"></a><tt class="py-lineno"> 25</tt>  <tt class="py-line"><tt class="py-docstring">    Relevant Data Table(s)</tt> </tt>
<a name="L26"></a><tt class="py-lineno"> 26</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L27"></a><tt class="py-lineno"> 27</tt>  <tt class="py-line"><tt class="py-docstring">    Available Acoustic </tt> </tt>
<a name="L28"></a><tt class="py-lineno"> 28</tt>  <tt class="py-line"><tt class="py-docstring">    Frequencies </tt> </tt>
<a name="L29"></a><tt class="py-lineno"> 29</tt>  <tt class="py-line"><tt class="py-docstring">    Value Frequency </tt> </tt>
<a name="L30"></a><tt class="py-lineno"> 30</tt>  <tt class="py-line"><tt class="py-docstring">    0 63 Hz </tt> </tt>
<a name="L31"></a><tt class="py-lineno"> 31</tt>  <tt class="py-line"><tt class="py-docstring">    1 125 Hz </tt> </tt>
<a name="L32"></a><tt class="py-lineno"> 32</tt>  <tt class="py-line"><tt class="py-docstring">    2 250 Hz </tt> </tt>
<a name="L33"></a><tt class="py-lineno"> 33</tt>  <tt class="py-line"><tt class="py-docstring">    3 500 Hz </tt> </tt>
<a name="L34"></a><tt class="py-lineno"> 34</tt>  <tt class="py-line"><tt class="py-docstring">    4 1000 Hz </tt> </tt>
<a name="L35"></a><tt class="py-lineno"> 35</tt>  <tt class="py-line"><tt class="py-docstring">    5 2000 Hz </tt> </tt>
<a name="L36"></a><tt class="py-lineno"> 36</tt>  <tt class="py-line"><tt class="py-docstring">    6 4000 Hz </tt> </tt>
<a name="L37"></a><tt class="py-lineno"> 37</tt>  <tt class="py-line"><tt class="py-docstring">    7 8000 Hz </tt> </tt>
<a name="L38"></a><tt class="py-lineno"> 38</tt>  <tt class="py-line"><tt class="py-docstring">    8 16000 Hz </tt> </tt>
<a name="L39"></a><tt class="py-lineno"> 39</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L40"></a><tt class="py-lineno"> 40</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L41"></a><tt class="py-lineno"> 41</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-1" class="py-name" targets="Module py2ecotect._util=py2ecotect._util-module.html"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-1', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-2" class="py-name" targets="Function py2ecotect._util._convert_args_to_string()=py2ecotect._util-module.html#_convert_args_to_string"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-2', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"calc.acousticresponse"</tt><tt class="py-op">,</tt>  </tt>
<a name="L42"></a><tt class="py-lineno"> 42</tt>  <tt class="py-line">                                                  <tt id="link-3" class="py-name" targets="Variable py2ecotect.app.movie.Movie.type=py2ecotect.app.movie.Movie-class.html#type"><a title="py2ecotect.app.movie.Movie.type" class="py-name" href="#" onclick="return doclink('link-3', 'type', 'link-3');">type</a></tt><tt class="py-op">,</tt> <tt class="py-name">frequency</tt><tt class="py-op">)</tt> </tt>
<a name="L43"></a><tt class="py-lineno"> 43</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-4" class="py-name" targets="Variable py2ecotect._app=py2ecotect-module.html#_app"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-4', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L44"></a><tt class="py-lineno"> 44</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="adjacencies"></a><div id="adjacencies-def"><a name="L45"></a><tt class="py-lineno"> 45</tt> <a class="py-toggle" href="#" id="adjacencies-toggle" onclick="return toggle('adjacencies');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.calculation-module.html#adjacencies">adjacencies</a><tt class="py-op">(</tt><tt class="py-param">sampleSize</tt><tt class="py-op">,</tt> <tt class="py-param">shading</tt><tt class="py-op">,</tt> <tt class="py-param">ignore</tt> <tt class="py-op">=</tt> <tt class="py-string">""</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="adjacencies-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="adjacencies-expanded"><a name="L46"></a><tt class="py-lineno"> 46</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L47"></a><tt class="py-lineno"> 47</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L48"></a><tt class="py-lineno"> 48</tt>  <tt class="py-line"><tt class="py-docstring">    Calculates inter-zonal adjacencies for all currently visible zones.</tt> </tt>
<a name="L49"></a><tt class="py-lineno"> 49</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L50"></a><tt class="py-lineno"> 50</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L51"></a><tt class="py-lineno"> 51</tt>  <tt class="py-line"><tt class="py-docstring">    This command takes the following parameters.</tt> </tt>
<a name="L52"></a><tt class="py-lineno"> 52</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L53"></a><tt class="py-lineno"> 53</tt>  <tt class="py-line"><tt class="py-docstring">    [ignore] </tt> </tt>
<a name="L54"></a><tt class="py-lineno"> 54</tt>  <tt class="py-line"><tt class="py-docstring">    If this optional string parameter is given instead of any others, the </tt> </tt>
<a name="L55"></a><tt class="py-lineno"> 55</tt>  <tt class="py-line"><tt class="py-docstring">    requirement to recalculate inter-zonal adjacencies will be ignored. </tt> </tt>
<a name="L56"></a><tt class="py-lineno"> 56</tt>  <tt class="py-line"><tt class="py-docstring">    This may be useful when you perform a zone-related operation that you </tt> </tt>
<a name="L57"></a><tt class="py-lineno"> 57</tt>  <tt class="py-line"><tt class="py-docstring">    know will not affect overshadowing or the thermal validity of spaces. </tt> </tt>
<a name="L58"></a><tt class="py-lineno"> 58</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L59"></a><tt class="py-lineno"> 59</tt>  <tt class="py-line"><tt class="py-docstring">    sampleSize </tt> </tt>
<a name="L60"></a><tt class="py-lineno"> 60</tt>  <tt class="py-line"><tt class="py-docstring">    To deal with geometry of any level of complexity, ECOTECT samples </tt> </tt>
<a name="L61"></a><tt class="py-lineno"> 61</tt>  <tt class="py-line"><tt class="py-docstring">    surfaces using pseudo-random points, each located somewhere within a </tt> </tt>
<a name="L62"></a><tt class="py-lineno"> 62</tt>  <tt class="py-line"><tt class="py-docstring">    regular grid. Use this parameter to set the size of this grid for each </tt> </tt>
<a name="L63"></a><tt class="py-lineno"> 63</tt>  <tt class="py-line"><tt class="py-docstring">    object in the default dimension units. Smaller sampling grid values will </tt> </tt>
<a name="L64"></a><tt class="py-lineno"> 64</tt>  <tt class="py-line"><tt class="py-docstring">    result in more accurate adjacency calculations, but will obviously take </tt> </tt>
<a name="L65"></a><tt class="py-lineno"> 65</tt>  <tt class="py-line"><tt class="py-docstring">    much longer to generate. </tt> </tt>
<a name="L66"></a><tt class="py-lineno"> 66</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L67"></a><tt class="py-lineno"> 67</tt>  <tt class="py-line"><tt class="py-docstring">    shading </tt> </tt>
<a name="L68"></a><tt class="py-lineno"> 68</tt>  <tt class="py-line"><tt class="py-docstring">    [true|false] Set this parameter to 'true' to have the calculation </tt> </tt>
<a name="L69"></a><tt class="py-lineno"> 69</tt>  <tt class="py-line"><tt class="py-docstring">    generate shading masks for each object. When set to 'false', no masks </tt> </tt>
<a name="L70"></a><tt class="py-lineno"> 70</tt>  <tt class="py-line"><tt class="py-docstring">    are calculated and shading is ignored.</tt> </tt>
<a name="L71"></a><tt class="py-lineno"> 71</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L72"></a><tt class="py-lineno"> 72</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L73"></a><tt class="py-lineno"> 73</tt>  <tt class="py-line">    <tt class="py-keyword">if</tt> <tt class="py-name">ignore</tt><tt class="py-op">.</tt><tt class="py-name">lower</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-string">"ignore"</tt><tt class="py-op">:</tt> </tt>
<a name="L74"></a><tt class="py-lineno"> 74</tt>  <tt class="py-line">        <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-5" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-5', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-6" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-6', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"calc.adjacencies"</tt> <tt class="py-op">,</tt>  </tt>
<a name="L75"></a><tt class="py-lineno"> 75</tt>  <tt class="py-line">                                                    <tt class="py-name">ignore</tt><tt class="py-op">)</tt> </tt>
<a name="L76"></a><tt class="py-lineno"> 76</tt>  <tt class="py-line">    <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L77"></a><tt class="py-lineno"> 77</tt>  <tt class="py-line">        <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-7" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-7', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-8" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-8', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"calc.adjacencies"</tt> <tt class="py-op">,</tt>  </tt>
<a name="L78"></a><tt class="py-lineno"> 78</tt>  <tt class="py-line">                                                    <tt class="py-name">sampleSize</tt><tt class="py-op">,</tt> <tt id="link-9" class="py-name" targets="Module py2ecotect.doc.shading=py2ecotect.doc.shading-module.html"><a title="py2ecotect.doc.shading" class="py-name" href="#" onclick="return doclink('link-9', 'shading', 'link-9');">shading</a></tt><tt class="py-op">)</tt> </tt>
<a name="L79"></a><tt class="py-lineno"> 79</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-10" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-10', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L80"></a><tt class="py-lineno"> 80</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="comfort"></a><div id="comfort-def"><a name="L81"></a><tt class="py-lineno"> 81</tt> <a class="py-toggle" href="#" id="comfort-toggle" onclick="return toggle('comfort');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.calculation-module.html#comfort">comfort</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="comfort-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="comfort-expanded"><a name="L82"></a><tt class="py-lineno"> 82</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L83"></a><tt class="py-lineno"> 83</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L84"></a><tt class="py-lineno"> 84</tt>  <tt class="py-line"><tt class="py-docstring">    Use this command to (re)calculate mean radiant temperatures and thermal </tt> </tt>
<a name="L85"></a><tt class="py-lineno"> 85</tt>  <tt class="py-line"><tt class="py-docstring">    comfort values if you have an a visible analysis grid set up within a </tt> </tt>
<a name="L86"></a><tt class="py-lineno"> 86</tt>  <tt class="py-line"><tt class="py-docstring">    valid thermal model. </tt> </tt>
<a name="L87"></a><tt class="py-lineno"> 87</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L88"></a><tt class="py-lineno"> 88</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L89"></a><tt class="py-lineno"> 89</tt>  <tt class="py-line"><tt class="py-docstring">    There are no parameters for this command.</tt> </tt>
<a name="L90"></a><tt class="py-lineno"> 90</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L91"></a><tt class="py-lineno"> 91</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L92"></a><tt class="py-lineno"> 92</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-11" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-11', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-string">"calc.comfort"</tt><tt class="py-op">)</tt> </tt>
</div><a name="L93"></a><tt class="py-lineno"> 93</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="insolation_1"></a><div id="insolation_1-def"><a name="L94"></a><tt class="py-lineno"> 94</tt> <a class="py-toggle" href="#" id="insolation_1-toggle" onclick="return toggle('insolation_1');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.calculation-module.html#insolation_1">insolation_1</a><tt class="py-op">(</tt><tt class="py-param">target</tt><tt class="py-op">,</tt> <tt class="py-param">type</tt><tt class="py-op">,</tt> <tt class="py-param">select3D</tt><tt class="py-op">,</tt> <tt class="py-param">accumulation</tt><tt class="py-op">,</tt> <tt class="py-param">metric</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="insolation_1-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="insolation_1-expanded"><a name="L95"></a><tt class="py-lineno"> 95</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L96"></a><tt class="py-lineno"> 96</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L97"></a><tt class="py-lineno"> 97</tt>  <tt class="py-line"><tt class="py-docstring">    Calculates incident solar radiation levels (insolation) over either the </tt> </tt>
<a name="L98"></a><tt class="py-lineno"> 98</tt>  <tt class="py-line"><tt class="py-docstring">    current analysis grid or objects within the model. </tt> </tt>
<a name="L99"></a><tt class="py-lineno"> 99</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L100"></a><tt class="py-lineno">100</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L101"></a><tt class="py-lineno">101</tt>  <tt class="py-line"><tt class="py-docstring">    This command takes the following parameters.</tt> </tt>
<a name="L102"></a><tt class="py-lineno">102</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L103"></a><tt class="py-lineno">103</tt>  <tt class="py-line"><tt class="py-docstring">    target </tt> </tt>
<a name="L104"></a><tt class="py-lineno">104</tt>  <tt class="py-line"><tt class="py-docstring">    [grid|objects] This parameter determines whether the insolation </tt> </tt>
<a name="L105"></a><tt class="py-lineno">105</tt>  <tt class="py-line"><tt class="py-docstring">    calculation is performed over the analysis grid or over objects. It can </tt> </tt>
<a name="L106"></a><tt class="py-lineno">106</tt>  <tt class="py-line"><tt class="py-docstring">    only have either the value 'grid' or 'objects'. Any other value will be </tt> </tt>
<a name="L107"></a><tt class="py-lineno">107</tt>  <tt class="py-line"><tt class="py-docstring">    intepreted as 'grid'. </tt> </tt>
<a name="L108"></a><tt class="py-lineno">108</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L109"></a><tt class="py-lineno">109</tt>  <tt class="py-line"><tt class="py-docstring">    type </tt> </tt>
<a name="L110"></a><tt class="py-lineno">110</tt>  <tt class="py-line"><tt class="py-docstring">    The type parameter sets the type of calculation to be performed, as </tt> </tt>
<a name="L111"></a><tt class="py-lineno">111</tt>  <tt class="py-line"><tt class="py-docstring">    shown in the following insolation types table. </tt> </tt>
<a name="L112"></a><tt class="py-lineno">112</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L113"></a><tt class="py-lineno">113</tt>  <tt class="py-line"><tt class="py-docstring">    select3D </tt> </tt>
<a name="L114"></a><tt class="py-lineno">114</tt>  <tt class="py-line"><tt class="py-docstring">    When calculating over the analysis grid, setting this boolean parameter </tt> </tt>
<a name="L115"></a><tt class="py-lineno">115</tt>  <tt class="py-line"><tt class="py-docstring">    to 'true' or 1 calculates insolation for the entire 3D volume of the </tt> </tt>
<a name="L116"></a><tt class="py-lineno">116</tt>  <tt class="py-line"><tt class="py-docstring">    grid. Setting it to 'false' or 0 means just the current 2D slice. When </tt> </tt>
<a name="L117"></a><tt class="py-lineno">117</tt>  <tt class="py-line"><tt class="py-docstring">    calculating over objects, setting this parameter to 'true' or 1 </tt> </tt>
<a name="L118"></a><tt class="py-lineno">118</tt>  <tt class="py-line"><tt class="py-docstring">    calculates insolation only for selected objects in the model. Setting it </tt> </tt>
<a name="L119"></a><tt class="py-lineno">119</tt>  <tt class="py-line"><tt class="py-docstring">    to 'false' or 0 means all visible objects. </tt> </tt>
<a name="L120"></a><tt class="py-lineno">120</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L121"></a><tt class="py-lineno">121</tt>  <tt class="py-line"><tt class="py-docstring">    accumulation </tt> </tt>
<a name="L122"></a><tt class="py-lineno">122</tt>  <tt class="py-line"><tt class="py-docstring">    Determines how to tabulate the results of the insolation calculation, </tt> </tt>
<a name="L123"></a><tt class="py-lineno">123</tt>  <tt class="py-line"><tt class="py-docstring">    based on values in the following solar accumulation table. </tt> </tt>
<a name="L124"></a><tt class="py-lineno">124</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L125"></a><tt class="py-lineno">125</tt>  <tt class="py-line"><tt class="py-docstring">    [metric] </tt> </tt>
<a name="L126"></a><tt class="py-lineno">126</tt>  <tt class="py-line"><tt class="py-docstring">    This parameter must be given if the type parameter has been set to </tt> </tt>
<a name="L127"></a><tt class="py-lineno">127</tt>  <tt class="py-line"><tt class="py-docstring">    reference. It determines the type of value to store as the 'before' </tt> </tt>
<a name="L128"></a><tt class="py-lineno">128</tt>  <tt class="py-line"><tt class="py-docstring">    reference, based on the following Insolation Metrics table. </tt> </tt>
<a name="L129"></a><tt class="py-lineno">129</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L130"></a><tt class="py-lineno">130</tt>  <tt class="py-line"><tt class="py-docstring">    Relevant Data Table(s)</tt> </tt>
<a name="L131"></a><tt class="py-lineno">131</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L132"></a><tt class="py-lineno">132</tt>  <tt class="py-line"><tt class="py-docstring">    Available Insolation Calculations </tt> </tt>
<a name="L133"></a><tt class="py-lineno">133</tt>  <tt class="py-line"><tt class="py-docstring">    Token Value Description </tt> </tt>
<a name="L134"></a><tt class="py-lineno">134</tt>  <tt class="py-line"><tt class="py-docstring">    incidence 0 Incident Solar Radiation on Points &amp; Surfaces </tt> </tt>
<a name="L135"></a><tt class="py-lineno">135</tt>  <tt class="py-line"><tt class="py-docstring">    absorption 1 Solar Absorbtion/Transmission of Object Surfaces </tt> </tt>
<a name="L136"></a><tt class="py-lineno">136</tt>  <tt class="py-line"><tt class="py-docstring">    skyfactor 2 Sky Factor &amp; Photosynthetically Active Radiation </tt> </tt>
<a name="L137"></a><tt class="py-lineno">137</tt>  <tt class="py-line"><tt class="py-docstring">    shading 3 Shading, Overshadowing and Sunlight Hours </tt> </tt>
<a name="L138"></a><tt class="py-lineno">138</tt>  <tt class="py-line"><tt class="py-docstring">    reference 4 COMPARE VALUE- Reference (Before) </tt> </tt>
<a name="L139"></a><tt class="py-lineno">139</tt>  <tt class="py-line"><tt class="py-docstring">    comparison 5 COMPARE VALUE- Comparison (After) </tt> </tt>
<a name="L140"></a><tt class="py-lineno">140</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L141"></a><tt class="py-lineno">141</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L142"></a><tt class="py-lineno">142</tt>  <tt class="py-line"><tt class="py-docstring">    Available Insolation Accumulations </tt> </tt>
<a name="L143"></a><tt class="py-lineno">143</tt>  <tt class="py-line"><tt class="py-docstring">    Token Value Description </tt> </tt>
<a name="L144"></a><tt class="py-lineno">144</tt>  <tt class="py-line"><tt class="py-docstring">    cumulative 0 Cumulative </tt> </tt>
<a name="L145"></a><tt class="py-lineno">145</tt>  <tt class="py-line"><tt class="py-docstring">    daily 1 Average Daily </tt> </tt>
<a name="L146"></a><tt class="py-lineno">146</tt>  <tt class="py-line"><tt class="py-docstring">    hourly 2 Average Hourly </tt> </tt>
<a name="L147"></a><tt class="py-lineno">147</tt>  <tt class="py-line"><tt class="py-docstring">    peak 3 Peak </tt> </tt>
<a name="L148"></a><tt class="py-lineno">148</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L149"></a><tt class="py-lineno">149</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L150"></a><tt class="py-lineno">150</tt>  <tt class="py-line"><tt class="py-docstring">    Available Insolation Metrics </tt> </tt>
<a name="L151"></a><tt class="py-lineno">151</tt>  <tt class="py-line"><tt class="py-docstring">    Token Value Description </tt> </tt>
<a name="L152"></a><tt class="py-lineno">152</tt>  <tt class="py-line"><tt class="py-docstring">    incident 0 Total Incident Radiation </tt> </tt>
<a name="L153"></a><tt class="py-lineno">153</tt>  <tt class="py-line"><tt class="py-docstring">    absorbed 1 Total Absorbed Radiation </tt> </tt>
<a name="L154"></a><tt class="py-lineno">154</tt>  <tt class="py-line"><tt class="py-docstring">    transmitted 2 Total Transmitted Radiation </tt> </tt>
<a name="L155"></a><tt class="py-lineno">155</tt>  <tt class="py-line"><tt class="py-docstring">    photosynthetic 3 Photosynth. Active Radiation </tt> </tt>
<a name="L156"></a><tt class="py-lineno">156</tt>  <tt class="py-line"><tt class="py-docstring">    shading 4 Avg Shading Percentage </tt> </tt>
<a name="L157"></a><tt class="py-lineno">157</tt>  <tt class="py-line"><tt class="py-docstring">    sunlight 5 Total Sunlight Hours </tt> </tt>
<a name="L158"></a><tt class="py-lineno">158</tt>  <tt class="py-line"><tt class="py-docstring">    sky 6 Total Visible Sky  </tt> </tt>
<a name="L159"></a><tt class="py-lineno">159</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L160"></a><tt class="py-lineno">160</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L161"></a><tt class="py-lineno">161</tt>  <tt class="py-line">     </tt>
<a name="L162"></a><tt class="py-lineno">162</tt>  <tt class="py-line">    <tt class="py-keyword">if</tt> <tt id="link-12" class="py-name"><a title="py2ecotect.app.movie.Movie.type" class="py-name" href="#" onclick="return doclink('link-12', 'type', 'link-3');">type</a></tt> <tt class="py-op">==</tt> <tt class="py-string">"reference"</tt> <tt class="py-keyword">and</tt>  <tt class="py-name">metric</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L163"></a><tt class="py-lineno">163</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> </tt>
<a name="L164"></a><tt class="py-lineno">164</tt>  <tt class="py-line">    <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L165"></a><tt class="py-lineno">165</tt>  <tt class="py-line">        <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-13" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-13', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-14" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-14', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"calc.insolation"</tt><tt class="py-op">,</tt>  </tt>
<a name="L166"></a><tt class="py-lineno">166</tt>  <tt class="py-line">                                                      <tt class="py-name">target</tt><tt class="py-op">,</tt> <tt id="link-15" class="py-name"><a title="py2ecotect.app.movie.Movie.type" class="py-name" href="#" onclick="return doclink('link-15', 'type', 'link-3');">type</a></tt><tt class="py-op">,</tt> <tt class="py-name">select3D</tt><tt class="py-op">,</tt>  </tt>
<a name="L167"></a><tt class="py-lineno">167</tt>  <tt class="py-line">                                                     <tt class="py-name">accumulation</tt><tt class="py-op">,</tt> <tt class="py-name">metric</tt><tt class="py-op">)</tt> </tt>
<a name="L168"></a><tt class="py-lineno">168</tt>  <tt class="py-line">        <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-16" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-16', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L169"></a><tt class="py-lineno">169</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="insolation_2"></a><div id="insolation_2-def"><a name="L170"></a><tt class="py-lineno">170</tt> <a class="py-toggle" href="#" id="insolation_2-toggle" onclick="return toggle('insolation_2');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.calculation-module.html#insolation_2">insolation_2</a><tt class="py-op">(</tt><tt class="py-param">period</tt><tt class="py-op">,</tt> <tt class="py-param">shading</tt><tt class="py-op">,</tt> <tt class="py-param">ground</tt><tt class="py-op">,</tt> <tt class="py-param">direct</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="insolation_2-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="insolation_2-expanded"><a name="L171"></a><tt class="py-lineno">171</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L172"></a><tt class="py-lineno">172</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L173"></a><tt class="py-lineno">173</tt>  <tt class="py-line"><tt class="py-docstring">    Calculates resource consumption within the model. </tt> </tt>
<a name="L174"></a><tt class="py-lineno">174</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L175"></a><tt class="py-lineno">175</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L176"></a><tt class="py-lineno">176</tt>  <tt class="py-line"><tt class="py-docstring">    This command takes the following parameters.</tt> </tt>
<a name="L177"></a><tt class="py-lineno">177</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L178"></a><tt class="py-lineno">178</tt>  <tt class="py-line"><tt class="py-docstring">    period </tt> </tt>
<a name="L179"></a><tt class="py-lineno">179</tt>  <tt class="py-line"><tt class="py-docstring">    The type parameter sets the type of resource calculation to be performed, </tt> </tt>
<a name="L180"></a><tt class="py-lineno">180</tt>  <tt class="py-line"><tt class="py-docstring">    as shown in the following Types of Solar Calculation Types table. </tt> </tt>
<a name="L181"></a><tt class="py-lineno">181</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L182"></a><tt class="py-lineno">182</tt>  <tt class="py-line"><tt class="py-docstring">    shading </tt> </tt>
<a name="L183"></a><tt class="py-lineno">183</tt>  <tt class="py-line"><tt class="py-docstring">    This parameter sets the type of accuracy of shading calculations to be </tt> </tt>
<a name="L184"></a><tt class="py-lineno">184</tt>  <tt class="py-line"><tt class="py-docstring">    performed, as shown in the following Solar Shading Accuracy table. </tt> </tt>
<a name="L185"></a><tt class="py-lineno">185</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L186"></a><tt class="py-lineno">186</tt>  <tt class="py-line"><tt class="py-docstring">    ground </tt> </tt>
<a name="L187"></a><tt class="py-lineno">187</tt>  <tt class="py-line"><tt class="py-docstring">    Determines whether ground reflections are considered in the calclation. </tt> </tt>
<a name="L188"></a><tt class="py-lineno">188</tt>  <tt class="py-line"><tt class="py-docstring">    This is a boolean value where 1 or true represents the affirmative and 0 </tt> </tt>
<a name="L189"></a><tt class="py-lineno">189</tt>  <tt class="py-line"><tt class="py-docstring">    or false the negative. </tt> </tt>
<a name="L190"></a><tt class="py-lineno">190</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L191"></a><tt class="py-lineno">191</tt>  <tt class="py-line"><tt class="py-docstring">    direct </tt> </tt>
<a name="L192"></a><tt class="py-lineno">192</tt>  <tt class="py-line"><tt class="py-docstring">    Determines whether only direct light is included in the solar </tt> </tt>
<a name="L193"></a><tt class="py-lineno">193</tt>  <tt class="py-line"><tt class="py-docstring">    calculation. This is a boolean value where 1 or true represents the </tt> </tt>
<a name="L194"></a><tt class="py-lineno">194</tt>  <tt class="py-line"><tt class="py-docstring">    affirmative and 0 or false the negative. </tt> </tt>
<a name="L195"></a><tt class="py-lineno">195</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L196"></a><tt class="py-lineno">196</tt>  <tt class="py-line"><tt class="py-docstring">    Relevant Data Table(s)</tt> </tt>
<a name="L197"></a><tt class="py-lineno">197</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L198"></a><tt class="py-lineno">198</tt>  <tt class="py-line"><tt class="py-docstring">    Available Types of Solar </tt> </tt>
<a name="L199"></a><tt class="py-lineno">199</tt>  <tt class="py-line"><tt class="py-docstring">    Calculation </tt> </tt>
<a name="L200"></a><tt class="py-lineno">200</tt>  <tt class="py-line"><tt class="py-docstring">    Token Description </tt> </tt>
<a name="L201"></a><tt class="py-lineno">201</tt>  <tt class="py-line"><tt class="py-docstring">    day Single day radiation. </tt> </tt>
<a name="L202"></a><tt class="py-lineno">202</tt>  <tt class="py-line"><tt class="py-docstring">    average Average daily radiation. </tt> </tt>
<a name="L203"></a><tt class="py-lineno">203</tt>  <tt class="py-line"><tt class="py-docstring">    total Total monthly radiation. </tt> </tt>
<a name="L204"></a><tt class="py-lineno">204</tt>  <tt class="py-line"><tt class="py-docstring">    full Full hourly radiation. </tt> </tt>
<a name="L205"></a><tt class="py-lineno">205</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L206"></a><tt class="py-lineno">206</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L207"></a><tt class="py-lineno">207</tt>  <tt class="py-line"><tt class="py-docstring">    Accuracy of Solar Calculations </tt> </tt>
<a name="L208"></a><tt class="py-lineno">208</tt>  <tt class="py-line"><tt class="py-docstring">    Value Description </tt> </tt>
<a name="L209"></a><tt class="py-lineno">209</tt>  <tt class="py-line"><tt class="py-docstring">    0 Full - break object into 25x25 grid. </tt> </tt>
<a name="L210"></a><tt class="py-lineno">210</tt>  <tt class="py-line"><tt class="py-docstring">    1 High - break object into 10x10 grid. </tt> </tt>
<a name="L211"></a><tt class="py-lineno">211</tt>  <tt class="py-line"><tt class="py-docstring">    2 Medium - break object into 5x5 grid. </tt> </tt>
<a name="L212"></a><tt class="py-lineno">212</tt>  <tt class="py-line"><tt class="py-docstring">    3 Low - use single point at object centre. </tt> </tt>
<a name="L213"></a><tt class="py-lineno">213</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L214"></a><tt class="py-lineno">214</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L215"></a><tt class="py-lineno">215</tt>  <tt class="py-line">    <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L216"></a><tt class="py-lineno">216</tt>  <tt class="py-line">        <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-17" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-17', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-18" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-18', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"calc.insolation"</tt><tt class="py-op">,</tt>  </tt>
<a name="L217"></a><tt class="py-lineno">217</tt>  <tt class="py-line">                                                      <tt class="py-name">period</tt><tt class="py-op">,</tt> <tt id="link-19" class="py-name"><a title="py2ecotect.doc.shading" class="py-name" href="#" onclick="return doclink('link-19', 'shading', 'link-9');">shading</a></tt><tt class="py-op">,</tt>  </tt>
<a name="L218"></a><tt class="py-lineno">218</tt>  <tt class="py-line">                                                      <tt class="py-name">ground</tt><tt class="py-op">,</tt> <tt class="py-name">direct</tt><tt class="py-op">)</tt> </tt>
<a name="L219"></a><tt class="py-lineno">219</tt>  <tt class="py-line">        <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-20" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-20', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
<a name="L220"></a><tt class="py-lineno">220</tt>  <tt class="py-line">    <tt class="py-keyword">except</tt><tt class="py-op">:</tt> </tt>
<a name="L221"></a><tt class="py-lineno">221</tt>  <tt class="py-line">        <tt class="py-keyword">print</tt> <tt class="py-string">"exception occured"</tt> </tt>
</div><a name="L222"></a><tt class="py-lineno">222</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="lighting"></a><div id="lighting-def"><a name="L223"></a><tt class="py-lineno">223</tt> <a class="py-toggle" href="#" id="lighting-toggle" onclick="return toggle('lighting');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.calculation-module.html#lighting">lighting</a><tt class="py-op">(</tt><tt class="py-param">target</tt><tt class="py-op">,</tt> <tt class="py-param">type</tt><tt class="py-op">,</tt> <tt class="py-param">select3D</tt><tt class="py-op">,</tt> <tt class="py-param">comparison</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="lighting-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="lighting-expanded"><a name="L224"></a><tt class="py-lineno">224</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L225"></a><tt class="py-lineno">225</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L226"></a><tt class="py-lineno">226</tt>  <tt class="py-line"><tt class="py-docstring">    Calculates daylight factors and lighting levels over either the current </tt> </tt>
<a name="L227"></a><tt class="py-lineno">227</tt>  <tt class="py-line"><tt class="py-docstring">    analysis grid or POINT objects within the model. </tt> </tt>
<a name="L228"></a><tt class="py-lineno">228</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L229"></a><tt class="py-lineno">229</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L230"></a><tt class="py-lineno">230</tt>  <tt class="py-line"><tt class="py-docstring">    This command takes the following parameters.</tt> </tt>
<a name="L231"></a><tt class="py-lineno">231</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L232"></a><tt class="py-lineno">232</tt>  <tt class="py-line"><tt class="py-docstring">    target </tt> </tt>
<a name="L233"></a><tt class="py-lineno">233</tt>  <tt class="py-line"><tt class="py-docstring">    [grid|points] This parameter determines whether the lighting calculation </tt> </tt>
<a name="L234"></a><tt class="py-lineno">234</tt>  <tt class="py-line"><tt class="py-docstring">    is performed over the analysis grid or over POINT objects. It can only </tt> </tt>
<a name="L235"></a><tt class="py-lineno">235</tt>  <tt class="py-line"><tt class="py-docstring">    have  either the value 'grid' or 'point'. Any other value will be </tt> </tt>
<a name="L236"></a><tt class="py-lineno">236</tt>  <tt class="py-line"><tt class="py-docstring">    intepreted as grid'. </tt> </tt>
<a name="L237"></a><tt class="py-lineno">237</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L238"></a><tt class="py-lineno">238</tt>  <tt class="py-line"><tt class="py-docstring">    type </tt> </tt>
<a name="L239"></a><tt class="py-lineno">239</tt>  <tt class="py-line"><tt class="py-docstring">    The type parameter sets the type of calculation to be performed, as </tt> </tt>
<a name="L240"></a><tt class="py-lineno">240</tt>  <tt class="py-line"><tt class="py-docstring">    shown in the following Lighting Types table. </tt> </tt>
<a name="L241"></a><tt class="py-lineno">241</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L242"></a><tt class="py-lineno">242</tt>  <tt class="py-line"><tt class="py-docstring">    select3D </tt> </tt>
<a name="L243"></a><tt class="py-lineno">243</tt>  <tt class="py-line"><tt class="py-docstring">    When calculating over the analysis grid, setting this boolean parameter </tt> </tt>
<a name="L244"></a><tt class="py-lineno">244</tt>  <tt class="py-line"><tt class="py-docstring">    to 'true' or 1 calculates lighting for the entire 3D volume of the grid. </tt> </tt>
<a name="L245"></a><tt class="py-lineno">245</tt>  <tt class="py-line"><tt class="py-docstring">    Setting it to 'false' or 0 means just the current 2D slice. When </tt> </tt>
<a name="L246"></a><tt class="py-lineno">246</tt>  <tt class="py-line"><tt class="py-docstring">    calculating over objects, setting this parameter to 'true' or 1 </tt> </tt>
<a name="L247"></a><tt class="py-lineno">247</tt>  <tt class="py-line"><tt class="py-docstring">    calculates lighting only for selected POINTs in the model. Setting it to </tt> </tt>
<a name="L248"></a><tt class="py-lineno">248</tt>  <tt class="py-line"><tt class="py-docstring">    'false' or 0 means all visible POINTs. </tt> </tt>
<a name="L249"></a><tt class="py-lineno">249</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L250"></a><tt class="py-lineno">250</tt>  <tt class="py-line"><tt class="py-docstring">    [comparison] </tt> </tt>
<a name="L251"></a><tt class="py-lineno">251</tt>  <tt class="py-line"><tt class="py-docstring">    The comparison parameter is optional and allows you to compare before </tt> </tt>
<a name="L252"></a><tt class="py-lineno">252</tt>  <tt class="py-line"><tt class="py-docstring">    and after results, as outlined in the Lighting Comparison following </tt> </tt>
<a name="L253"></a><tt class="py-lineno">253</tt>  <tt class="py-line"><tt class="py-docstring">    table. </tt> </tt>
<a name="L254"></a><tt class="py-lineno">254</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L255"></a><tt class="py-lineno">255</tt>  <tt class="py-line"><tt class="py-docstring">    Relevant Data Table(s)</tt> </tt>
<a name="L256"></a><tt class="py-lineno">256</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L257"></a><tt class="py-lineno">257</tt>  <tt class="py-line"><tt class="py-docstring">    Available Lighting Calculations </tt> </tt>
<a name="L258"></a><tt class="py-lineno">258</tt>  <tt class="py-line"><tt class="py-docstring">    Token Value Description </tt> </tt>
<a name="L259"></a><tt class="py-lineno">259</tt>  <tt class="py-line"><tt class="py-docstring">    daylight 0 Natural Light - Daylight Factors &amp; Levels </tt> </tt>
<a name="L260"></a><tt class="py-lineno">260</tt>  <tt class="py-line"><tt class="py-docstring">    overall 1 Overall Light - Daylight and Electric Levels </tt> </tt>
<a name="L261"></a><tt class="py-lineno">261</tt>  <tt class="py-line"><tt class="py-docstring">    compare 2 Comparison against previous calculation </tt> </tt>
<a name="L262"></a><tt class="py-lineno">262</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L263"></a><tt class="py-lineno">263</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L264"></a><tt class="py-lineno">264</tt>  <tt class="py-line"><tt class="py-docstring">    Available Lighting Comparisons </tt> </tt>
<a name="L265"></a><tt class="py-lineno">265</tt>  <tt class="py-line"><tt class="py-docstring">    Value Description </tt> </tt>
<a name="L266"></a><tt class="py-lineno">266</tt>  <tt class="py-line"><tt class="py-docstring">    0 Normal: Store Calculated Values </tt> </tt>
<a name="L267"></a><tt class="py-lineno">267</tt>  <tt class="py-line"><tt class="py-docstring">    1 Compare: After / Before - as a percentage (%) </tt> </tt>
<a name="L268"></a><tt class="py-lineno">268</tt>  <tt class="py-line"><tt class="py-docstring">    2 Compare: Before / After - as a percentage (%) </tt> </tt>
<a name="L269"></a><tt class="py-lineno">269</tt>  <tt class="py-line"><tt class="py-docstring">    3 Compare: After - Before </tt> </tt>
<a name="L270"></a><tt class="py-lineno">270</tt>  <tt class="py-line"><tt class="py-docstring">    4 Compare: Before - After </tt> </tt>
<a name="L271"></a><tt class="py-lineno">271</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L272"></a><tt class="py-lineno">272</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L273"></a><tt class="py-lineno">273</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-21" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-21', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-22" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-22', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"calc.lighting"</tt><tt class="py-op">,</tt> <tt class="py-name">target</tt><tt class="py-op">,</tt>  </tt>
<a name="L274"></a><tt class="py-lineno">274</tt>  <tt class="py-line">                                                  <tt id="link-23" class="py-name"><a title="py2ecotect.app.movie.Movie.type" class="py-name" href="#" onclick="return doclink('link-23', 'type', 'link-3');">type</a></tt><tt class="py-op">,</tt> <tt class="py-name">select3D</tt><tt class="py-op">,</tt>  </tt>
<a name="L275"></a><tt class="py-lineno">275</tt>  <tt class="py-line">                                                  <tt class="py-name">comparison</tt><tt class="py-op">)</tt> </tt>
<a name="L276"></a><tt class="py-lineno">276</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-24" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-24', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L277"></a><tt class="py-lineno">277</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="resources"></a><div id="resources-def"><a name="L278"></a><tt class="py-lineno">278</tt> <a class="py-toggle" href="#" id="resources-toggle" onclick="return toggle('resources');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.calculation-module.html#resources">resources</a><tt class="py-op">(</tt><tt class="py-param">type</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="resources-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="resources-expanded"><a name="L279"></a><tt class="py-lineno">279</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L280"></a><tt class="py-lineno">280</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L281"></a><tt class="py-lineno">281</tt>  <tt class="py-line"><tt class="py-docstring">    Calculates resource consumption within the model. </tt> </tt>
<a name="L282"></a><tt class="py-lineno">282</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L283"></a><tt class="py-lineno">283</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L284"></a><tt class="py-lineno">284</tt>  <tt class="py-line"><tt class="py-docstring">    This command takes the following parameters.</tt> </tt>
<a name="L285"></a><tt class="py-lineno">285</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L286"></a><tt class="py-lineno">286</tt>  <tt class="py-line"><tt class="py-docstring">    type </tt> </tt>
<a name="L287"></a><tt class="py-lineno">287</tt>  <tt class="py-line"><tt class="py-docstring">    The type parameter sets the type of resource calculation to be </tt> </tt>
<a name="L288"></a><tt class="py-lineno">288</tt>  <tt class="py-line"><tt class="py-docstring">    performed, as shown in the following resource calculation types table. </tt> </tt>
<a name="L289"></a><tt class="py-lineno">289</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L290"></a><tt class="py-lineno">290</tt>  <tt class="py-line"><tt class="py-docstring">    Relevant Data Table(s)</tt> </tt>
<a name="L291"></a><tt class="py-lineno">291</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L292"></a><tt class="py-lineno">292</tt>  <tt class="py-line"><tt class="py-docstring">    Available Resource Calculations </tt> </tt>
<a name="L293"></a><tt class="py-lineno">293</tt>  <tt class="py-line"><tt class="py-docstring">    Token Description </tt> </tt>
<a name="L294"></a><tt class="py-lineno">294</tt>  <tt class="py-line"><tt class="py-docstring">    energy Daily Energy Use </tt> </tt>
<a name="L295"></a><tt class="py-lineno">295</tt>  <tt class="py-line"><tt class="py-docstring">    load Daily Load Matching </tt> </tt>
<a name="L296"></a><tt class="py-lineno">296</tt>  <tt class="py-line"><tt class="py-docstring">    solar Hourly Solar Collection </tt> </tt>
<a name="L297"></a><tt class="py-lineno">297</tt>  <tt class="py-line"><tt class="py-docstring">    electricity Hourly Electricity Use </tt> </tt>
<a name="L298"></a><tt class="py-lineno">298</tt>  <tt class="py-line"><tt class="py-docstring">    water Hourly Water Use </tt> </tt>
<a name="L299"></a><tt class="py-lineno">299</tt>  <tt class="py-line"><tt class="py-docstring">    waste Hourly Waste Water </tt> </tt>
<a name="L300"></a><tt class="py-lineno">300</tt>  <tt class="py-line"><tt class="py-docstring">    fueloil Hourly Fuel Oil Use </tt> </tt>
<a name="L301"></a><tt class="py-lineno">301</tt>  <tt class="py-line"><tt class="py-docstring">    kerosene Hourly Kerosene Use </tt> </tt>
<a name="L302"></a><tt class="py-lineno">302</tt>  <tt class="py-line"><tt class="py-docstring">    natgas Hourly Nat. Gas Use </tt> </tt>
<a name="L303"></a><tt class="py-lineno">303</tt>  <tt class="py-line"><tt class="py-docstring">    lpgas Hourly LP Gas Use </tt> </tt>
<a name="L304"></a><tt class="py-lineno">304</tt>  <tt class="py-line"><tt class="py-docstring">    coal Hourly Coal Use </tt> </tt>
<a name="L305"></a><tt class="py-lineno">305</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L306"></a><tt class="py-lineno">306</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L307"></a><tt class="py-lineno">307</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-25" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-25', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-26" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-26', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"calc.resources"</tt><tt class="py-op">,</tt> <tt id="link-27" class="py-name"><a title="py2ecotect.app.movie.Movie.type" class="py-name" href="#" onclick="return doclink('link-27', 'type', 'link-3');">type</a></tt><tt class="py-op">)</tt> </tt>
<a name="L308"></a><tt class="py-lineno">308</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-28" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-28', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L309"></a><tt class="py-lineno">309</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="shading_percentage"></a><div id="shading_percentage-def"><a name="L310"></a><tt class="py-lineno">310</tt> <a class="py-toggle" href="#" id="shading_percentage-toggle" onclick="return toggle('shading_percentage');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.calculation-module.html#shading_percentage">shading_percentage</a><tt class="py-op">(</tt><tt class="py-param">cumulative</tt><tt class="py-op">,</tt> <tt class="py-param">startDay</tt><tt class="py-op">,</tt> <tt class="py-param">stopDay</tt><tt class="py-op">,</tt> <tt class="py-param">startTime</tt><tt class="py-op">,</tt>  </tt>
<a name="L311"></a><tt class="py-lineno">311</tt>  <tt class="py-line">                       <tt class="py-param">stopTime</tt><tt class="py-op">,</tt> <tt class="py-param">shadingType</tt> <tt class="py-op">=</tt> <tt class="py-string">"percentage"</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="shading_percentage-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="shading_percentage-expanded"><a name="L312"></a><tt class="py-lineno">312</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L313"></a><tt class="py-lineno">313</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L314"></a><tt class="py-lineno">314</tt>  <tt class="py-line"><tt class="py-docstring">    Calculates the shading mask for the currently selected object. The </tt> </tt>
<a name="L315"></a><tt class="py-lineno">315</tt>  <tt class="py-line"><tt class="py-docstring">    command suffix refers to the shading information to be calculated, as </tt> </tt>
<a name="L316"></a><tt class="py-lineno">316</tt>  <tt class="py-line"><tt class="py-docstring">    outlined in the following Available Shading Calculations table. The </tt> </tt>
<a name="L317"></a><tt class="py-lineno">317</tt>  <tt class="py-line"><tt class="py-docstring">    optional parameters only apply to solar stress calculations. If not </tt> </tt>
<a name="L318"></a><tt class="py-lineno">318</tt>  <tt class="py-line"><tt class="py-docstring">    included, these default to the full year (0-365) and all day (0-24). </tt> </tt>
<a name="L319"></a><tt class="py-lineno">319</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L320"></a><tt class="py-lineno">320</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L321"></a><tt class="py-lineno">321</tt>  <tt class="py-line"><tt class="py-docstring">    This command takes the following parameters.</tt> </tt>
<a name="L322"></a><tt class="py-lineno">322</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L323"></a><tt class="py-lineno">323</tt>  <tt class="py-line"><tt class="py-docstring">    cumulative </tt> </tt>
<a name="L324"></a><tt class="py-lineno">324</tt>  <tt class="py-line"><tt class="py-docstring">    A boolean value determining if solar radiation should show cumulative </tt> </tt>
<a name="L325"></a><tt class="py-lineno">325</tt>  <tt class="py-line"><tt class="py-docstring">    annual results rather than hourly total stress values. </tt> </tt>
<a name="L326"></a><tt class="py-lineno">326</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L327"></a><tt class="py-lineno">327</tt>  <tt class="py-line"><tt class="py-docstring">    startDay </tt> </tt>
<a name="L328"></a><tt class="py-lineno">328</tt>  <tt class="py-line"><tt class="py-docstring">    The starting date for the calculation. This is a julian date, a number </tt> </tt>
<a name="L329"></a><tt class="py-lineno">329</tt>  <tt class="py-line"><tt class="py-docstring">    between 1 and 365. </tt> </tt>
<a name="L330"></a><tt class="py-lineno">330</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L331"></a><tt class="py-lineno">331</tt>  <tt class="py-line"><tt class="py-docstring">    stopDay </tt> </tt>
<a name="L332"></a><tt class="py-lineno">332</tt>  <tt class="py-line"><tt class="py-docstring">    The end date for the calculation. This is a julian date, a number </tt> </tt>
<a name="L333"></a><tt class="py-lineno">333</tt>  <tt class="py-line"><tt class="py-docstring">    between 1 and 365. </tt> </tt>
<a name="L334"></a><tt class="py-lineno">334</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L335"></a><tt class="py-lineno">335</tt>  <tt class="py-line"><tt class="py-docstring">    startTime </tt> </tt>
<a name="L336"></a><tt class="py-lineno">336</tt>  <tt class="py-line"><tt class="py-docstring">    Determines the starting time for the calculation. This is a decimal </tt> </tt>
<a name="L337"></a><tt class="py-lineno">337</tt>  <tt class="py-line"><tt class="py-docstring">    value between 0.00 and 23.99. </tt> </tt>
<a name="L338"></a><tt class="py-lineno">338</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L339"></a><tt class="py-lineno">339</tt>  <tt class="py-line"><tt class="py-docstring">    stopTime </tt> </tt>
<a name="L340"></a><tt class="py-lineno">340</tt>  <tt class="py-line"><tt class="py-docstring">    Determines the end time for the calculation. This is a decimal value </tt> </tt>
<a name="L341"></a><tt class="py-lineno">341</tt>  <tt class="py-line"><tt class="py-docstring">    between 0.00 and 23.99.</tt> </tt>
<a name="L342"></a><tt class="py-lineno">342</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L343"></a><tt class="py-lineno">343</tt>  <tt class="py-line"><tt class="py-docstring">    shadingType</tt> </tt>
<a name="L344"></a><tt class="py-lineno">344</tt>  <tt class="py-line"><tt class="py-docstring">    Can be percentage, total, diffuse or direct. Default is percentage</tt> </tt>
<a name="L345"></a><tt class="py-lineno">345</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L346"></a><tt class="py-lineno">346</tt>  <tt class="py-line"><tt class="py-docstring">    Relevant Data Table(s)</tt> </tt>
<a name="L347"></a><tt class="py-lineno">347</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L348"></a><tt class="py-lineno">348</tt>  <tt class="py-line"><tt class="py-docstring">    Available Thermal Calculations </tt> </tt>
<a name="L349"></a><tt class="py-lineno">349</tt>  <tt class="py-line"><tt class="py-docstring">    Token Description </tt> </tt>
<a name="L350"></a><tt class="py-lineno">350</tt>  <tt class="py-line"><tt class="py-docstring">    temperatures Hourly temperatures for current day. </tt> </tt>
<a name="L351"></a><tt class="py-lineno">351</tt>  <tt class="py-line"><tt class="py-docstring">    gains Hourly heat gains for current day. </tt> </tt>
<a name="L352"></a><tt class="py-lineno">352</tt>  <tt class="py-line"><tt class="py-docstring">    loads Monthly heating and cooling loads. </tt> </tt>
<a name="L353"></a><tt class="py-lineno">353</tt>  <tt class="py-line"><tt class="py-docstring">    distribution Temperature distribution. </tt> </tt>
<a name="L354"></a><tt class="py-lineno">354</tt>  <tt class="py-line"><tt class="py-docstring">    fabricgains Average monthly-hourly fabric heat flow. </tt> </tt>
<a name="L355"></a><tt class="py-lineno">355</tt>  <tt class="py-line"><tt class="py-docstring">    indirectgains Average monthly-hourly indirect solar gains. </tt> </tt>
<a name="L356"></a><tt class="py-lineno">356</tt>  <tt class="py-line"><tt class="py-docstring">    directgains Average monthly-hourly direct solar gains </tt> </tt>
<a name="L357"></a><tt class="py-lineno">357</tt>  <tt class="py-line"><tt class="py-docstring">    ventilationgains Average monthly-hourly ventilation gains. </tt> </tt>
<a name="L358"></a><tt class="py-lineno">358</tt>  <tt class="py-line"><tt class="py-docstring">    internalgains Average monthly-hourly internal gains. </tt> </tt>
<a name="L359"></a><tt class="py-lineno">359</tt>  <tt class="py-line"><tt class="py-docstring">    zonalgains Average monthly-hourly inter-zonal gains. </tt> </tt>
<a name="L360"></a><tt class="py-lineno">360</tt>  <tt class="py-line"><tt class="py-docstring">    totalgains Average monthly-hourly total space gains. </tt> </tt>
<a name="L361"></a><tt class="py-lineno">361</tt>  <tt class="py-line"><tt class="py-docstring">    passivegains Passive gains breakdown. </tt> </tt>
<a name="L362"></a><tt class="py-lineno">362</tt>  <tt class="py-line"><tt class="py-docstring">    adaptability Passive adaptibility index. </tt> </tt>
<a name="L363"></a><tt class="py-lineno">363</tt>  <tt class="py-line"><tt class="py-docstring">    comparison Temperature/gains comparison . </tt> </tt>
<a name="L364"></a><tt class="py-lineno">364</tt>  <tt class="py-line"><tt class="py-docstring">    degreedays Monthly degree days. </tt> </tt>
<a name="L365"></a><tt class="py-lineno">365</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L366"></a><tt class="py-lineno">366</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L367"></a><tt class="py-lineno">367</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-29" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-29', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-30" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-30', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"calc.shading."</tt> <tt class="py-op">+</tt>  </tt>
<a name="L368"></a><tt class="py-lineno">368</tt>  <tt class="py-line">                                                  <tt class="py-name">shadingType</tt><tt class="py-op">,</tt><tt class="py-name">cumulative</tt><tt class="py-op">,</tt>  </tt>
<a name="L369"></a><tt class="py-lineno">369</tt>  <tt class="py-line">                                                  <tt class="py-name">startDay</tt><tt class="py-op">,</tt> <tt class="py-name">stopDay</tt><tt class="py-op">,</tt>  </tt>
<a name="L370"></a><tt class="py-lineno">370</tt>  <tt class="py-line">                                                  <tt class="py-name">startTime</tt><tt class="py-op">,</tt> <tt class="py-name">stopTime</tt><tt class="py-op">)</tt> </tt>
<a name="L371"></a><tt class="py-lineno">371</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-31" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-31', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L372"></a><tt class="py-lineno">372</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="thermal_temperatures"></a><div id="thermal_temperatures-def"><a name="L373"></a><tt class="py-lineno">373</tt> <a class="py-toggle" href="#" id="thermal_temperatures-toggle" onclick="return toggle('thermal_temperatures');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.calculation-module.html#thermal_temperatures">thermal_temperatures</a><tt class="py-op">(</tt><tt class="py-param">calc_type</tt><tt class="py-op">,</tt> <tt class="py-param">zone</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="thermal_temperatures-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="thermal_temperatures-expanded"><a name="L374"></a><tt class="py-lineno">374</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L375"></a><tt class="py-lineno">375</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L376"></a><tt class="py-lineno">376</tt>  <tt class="py-line"><tt class="py-docstring">    Use these methods to invoke thermal calculations. The command suffixes </tt> </tt>
<a name="L377"></a><tt class="py-lineno">377</tt>  <tt class="py-line"><tt class="py-docstring">    refer to the different thermal calculation types as shown in the </tt> </tt>
<a name="L378"></a><tt class="py-lineno">378</tt>  <tt class="py-line"><tt class="py-docstring">    following Available Thermal Calculations table. Calculation types relate </tt> </tt>
<a name="L379"></a><tt class="py-lineno">379</tt>  <tt class="py-line"><tt class="py-docstring">    directly to the Thermal Calculation selector in the Thermal Analysis tab </tt> </tt>
<a name="L380"></a><tt class="py-lineno">380</tt>  <tt class="py-line"><tt class="py-docstring">    of the Graphical Results dialog. </tt> </tt>
<a name="L381"></a><tt class="py-lineno">381</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L382"></a><tt class="py-lineno">382</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L383"></a><tt class="py-lineno">383</tt>  <tt class="py-line"><tt class="py-docstring">    This command takes the following parameters.</tt> </tt>
<a name="L384"></a><tt class="py-lineno">384</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L385"></a><tt class="py-lineno">385</tt>  <tt class="py-line"><tt class="py-docstring">    calc_type</tt> </tt>
<a name="L386"></a><tt class="py-lineno">386</tt>  <tt class="py-line"><tt class="py-docstring">    Refer to  the thermal calculations table below</tt> </tt>
<a name="L387"></a><tt class="py-lineno">387</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L388"></a><tt class="py-lineno">388</tt>  <tt class="py-line"><tt class="py-docstring">    [zone] </tt> </tt>
<a name="L389"></a><tt class="py-lineno">389</tt>  <tt class="py-line"><tt class="py-docstring">    This optional parameter can be used to specify the zero-based index of a </tt> </tt>
<a name="L390"></a><tt class="py-lineno">390</tt>  <tt class="py-line"><tt class="py-docstring">    zone to use for the calculation. This paramater only applies to the </tt> </tt>
<a name="L391"></a><tt class="py-lineno">391</tt>  <tt class="py-line"><tt class="py-docstring">    .gains and ...gains calculations, and relates directly to the Highlight </tt> </tt>
<a name="L392"></a><tt class="py-lineno">392</tt>  <tt class="py-line"><tt class="py-docstring">    Zone selector (however the zone index is always given as the absolute </tt> </tt>
<a name="L393"></a><tt class="py-lineno">393</tt>  <tt class="py-line"><tt class="py-docstring">    index in the entire zone list). </tt> </tt>
<a name="L394"></a><tt class="py-lineno">394</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L395"></a><tt class="py-lineno">395</tt>  <tt class="py-line"><tt class="py-docstring">    Relevant Data Table(s)</tt> </tt>
<a name="L396"></a><tt class="py-lineno">396</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L397"></a><tt class="py-lineno">397</tt>  <tt class="py-line"><tt class="py-docstring">    Available Thermal Calculations </tt> </tt>
<a name="L398"></a><tt class="py-lineno">398</tt>  <tt class="py-line"><tt class="py-docstring">    Token Description </tt> </tt>
<a name="L399"></a><tt class="py-lineno">399</tt>  <tt class="py-line"><tt class="py-docstring">    temperatures Hourly temperatures for current day. </tt> </tt>
<a name="L400"></a><tt class="py-lineno">400</tt>  <tt class="py-line"><tt class="py-docstring">    gains Hourly heat gains for current day. </tt> </tt>
<a name="L401"></a><tt class="py-lineno">401</tt>  <tt class="py-line"><tt class="py-docstring">    loads Monthly heating and cooling loads. </tt> </tt>
<a name="L402"></a><tt class="py-lineno">402</tt>  <tt class="py-line"><tt class="py-docstring">    distribution Temperature distribution. </tt> </tt>
<a name="L403"></a><tt class="py-lineno">403</tt>  <tt class="py-line"><tt class="py-docstring">    fabricgains Average monthly-hourly fabric heat flow. </tt> </tt>
<a name="L404"></a><tt class="py-lineno">404</tt>  <tt class="py-line"><tt class="py-docstring">    indirectgains Average monthly-hourly indirect solar gains. </tt> </tt>
<a name="L405"></a><tt class="py-lineno">405</tt>  <tt class="py-line"><tt class="py-docstring">    directgains Average monthly-hourly direct solar gains </tt> </tt>
<a name="L406"></a><tt class="py-lineno">406</tt>  <tt class="py-line"><tt class="py-docstring">    ventilationgains Average monthly-hourly ventilation gains. </tt> </tt>
<a name="L407"></a><tt class="py-lineno">407</tt>  <tt class="py-line"><tt class="py-docstring">    internalgains Average monthly-hourly internal gains. </tt> </tt>
<a name="L408"></a><tt class="py-lineno">408</tt>  <tt class="py-line"><tt class="py-docstring">    zonalgains Average monthly-hourly inter-zonal gains. </tt> </tt>
<a name="L409"></a><tt class="py-lineno">409</tt>  <tt class="py-line"><tt class="py-docstring">    totalgains Average monthly-hourly total space gains. </tt> </tt>
<a name="L410"></a><tt class="py-lineno">410</tt>  <tt class="py-line"><tt class="py-docstring">    passivegains Passive gains breakdown. </tt> </tt>
<a name="L411"></a><tt class="py-lineno">411</tt>  <tt class="py-line"><tt class="py-docstring">    adaptability Passive adaptibility index. </tt> </tt>
<a name="L412"></a><tt class="py-lineno">412</tt>  <tt class="py-line"><tt class="py-docstring">    comparison Temperature/gains comparison . </tt> </tt>
<a name="L413"></a><tt class="py-lineno">413</tt>  <tt class="py-line"><tt class="py-docstring">    degreedays Monthly degree days. </tt> </tt>
<a name="L414"></a><tt class="py-lineno">414</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L415"></a><tt class="py-lineno">415</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L416"></a><tt class="py-lineno">416</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-32" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-32', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-33" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-33', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"calc.thermal."</tt> <tt class="py-op">+</tt>  </tt>
<a name="L417"></a><tt class="py-lineno">417</tt>  <tt class="py-line">                                                  <tt class="py-name">calc_type</tt><tt class="py-op">,</tt> <tt id="link-34" class="py-name" targets="Method py2ecotect.doc.select.Select.zone()=py2ecotect.doc.select.Select-class.html#zone,Module py2ecotect.ent.zone=py2ecotect.ent.zone-module.html,Variable py2ecotect.obj._object._Object.zone=py2ecotect.obj._object._Object-class.html#zone"><a title="py2ecotect.doc.select.Select.zone
py2ecotect.ent.zone
py2ecotect.obj._object._Object.zone" class="py-name" href="#" onclick="return doclink('link-34', 'zone', 'link-34');">zone</a></tt><tt class="py-op">)</tt> </tt>
<a name="L418"></a><tt class="py-lineno">418</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-35" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-35', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L419"></a><tt class="py-lineno">419</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="volumes"></a><div id="volumes-def"><a name="L420"></a><tt class="py-lineno">420</tt> <a class="py-toggle" href="#" id="volumes-toggle" onclick="return toggle('volumes');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.calculation-module.html#volumes">volumes</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="volumes-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="volumes-expanded"><a name="L421"></a><tt class="py-lineno">421</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L422"></a><tt class="py-lineno">422</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L423"></a><tt class="py-lineno">423</tt>  <tt class="py-line"><tt class="py-docstring">    Calculates zone volumes for all currently visible zones. </tt> </tt>
<a name="L424"></a><tt class="py-lineno">424</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L425"></a><tt class="py-lineno">425</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L426"></a><tt class="py-lineno">426</tt>  <tt class="py-line"><tt class="py-docstring">    There are no parameters for this command.</tt> </tt>
<a name="L427"></a><tt class="py-lineno">427</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L428"></a><tt class="py-lineno">428</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L429"></a><tt class="py-lineno">429</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-36" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-36', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-string">"calc.volumes"</tt><tt class="py-op">)</tt> </tt>
</div><a name="L430"></a><tt class="py-lineno">430</tt>  <tt class="py-line"><tt class="py-comment">#===========================================================================</tt> </tt>
<a name="L431"></a><tt class="py-lineno">431</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Getters and Setters</tt> </tt>
<a name="L432"></a><tt class="py-lineno">432</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#===========================================================================</tt> </tt>
<a name="get_dates"></a><div id="get_dates-def"><a name="L433"></a><tt class="py-lineno">433</tt> <a class="py-toggle" href="#" id="get_dates-toggle" onclick="return toggle('get_dates');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.calculation-module.html#get_dates">get_dates</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_dates-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="get_dates-expanded"><a name="L434"></a><tt class="py-lineno">434</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L435"></a><tt class="py-lineno">435</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L436"></a><tt class="py-lineno">436</tt>  <tt class="py-line"><tt class="py-docstring">    Retrieves the range of dates used for calculations. Up to three values </tt> </tt>
<a name="L437"></a><tt class="py-lineno">437</tt>  <tt class="py-line"><tt class="py-docstring">    are returned, being the startDay, the stopDay, and the optional </tt> </tt>
<a name="L438"></a><tt class="py-lineno">438</tt>  <tt class="py-line"><tt class="py-docstring">    [incDay], which determines if the start and stop days are inclusive of </tt> </tt>
<a name="L439"></a><tt class="py-lineno">439</tt>  <tt class="py-line"><tt class="py-docstring">    the date range. </tt> </tt>
<a name="L440"></a><tt class="py-lineno">440</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L441"></a><tt class="py-lineno">441</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L442"></a><tt class="py-lineno">442</tt>  <tt class="py-line"><tt class="py-docstring">    There are no parameters for this property.</tt> </tt>
<a name="L443"></a><tt class="py-lineno">443</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L444"></a><tt class="py-lineno">444</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L445"></a><tt class="py-lineno">445</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L446"></a><tt class="py-lineno">446</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L447"></a><tt class="py-lineno">447</tt>  <tt class="py-line"><tt class="py-docstring">    startDay </tt> </tt>
<a name="L448"></a><tt class="py-lineno">448</tt>  <tt class="py-line"><tt class="py-docstring">    The starting date for the calculation. This is a julian date, being a </tt> </tt>
<a name="L449"></a><tt class="py-lineno">449</tt>  <tt class="py-line"><tt class="py-docstring">    number between 1 and 365. </tt> </tt>
<a name="L450"></a><tt class="py-lineno">450</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L451"></a><tt class="py-lineno">451</tt>  <tt class="py-line"><tt class="py-docstring">    stopDay </tt> </tt>
<a name="L452"></a><tt class="py-lineno">452</tt>  <tt class="py-line"><tt class="py-docstring">    The end date for the calculation. This is a julian date, being a number </tt> </tt>
<a name="L453"></a><tt class="py-lineno">453</tt>  <tt class="py-line"><tt class="py-docstring">    between 1 and 365. </tt> </tt>
<a name="L454"></a><tt class="py-lineno">454</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L455"></a><tt class="py-lineno">455</tt>  <tt class="py-line"><tt class="py-docstring">    incDay </tt> </tt>
<a name="L456"></a><tt class="py-lineno">456</tt>  <tt class="py-line"><tt class="py-docstring">    a boolean result (0 or 1) indicating if the start and stop dates are </tt> </tt>
<a name="L457"></a><tt class="py-lineno">457</tt>  <tt class="py-line"><tt class="py-docstring">    inclusive within the date range. </tt> </tt>
<a name="L458"></a><tt class="py-lineno">458</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L459"></a><tt class="py-lineno">459</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L460"></a><tt class="py-lineno">460</tt>  <tt class="py-line">    <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-37" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-37', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-string">"get.calc.dates"</tt><tt class="py-op">)</tt> </tt>
<a name="L461"></a><tt class="py-lineno">461</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-38" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-38', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-39" class="py-name" targets="Function py2ecotect._util._convert_str_to_list()=py2ecotect._util-module.html#_convert_str_to_list"><a title="py2ecotect._util._convert_str_to_list" class="py-name" href="#" onclick="return doclink('link-39', '_convert_str_to_list', 'link-39');">_convert_str_to_list</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">int</tt><tt class="py-op">,</tt> <tt class="py-name">int</tt><tt class="py-op">,</tt> <tt class="py-name">bool</tt><tt class="py-op">)</tt> </tt>
</div><a name="L462"></a><tt class="py-lineno">462</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="set_dates"></a><div id="set_dates-def"><a name="L463"></a><tt class="py-lineno">463</tt> <a class="py-toggle" href="#" id="set_dates-toggle" onclick="return toggle('set_dates');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.calculation-module.html#set_dates">set_dates</a><tt class="py-op">(</tt><tt class="py-param">startDay</tt><tt class="py-op">,</tt> <tt class="py-param">stopDay</tt><tt class="py-op">,</tt> <tt class="py-param">incDay</tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="set_dates-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="set_dates-expanded"><a name="L464"></a><tt class="py-lineno">464</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L465"></a><tt class="py-lineno">465</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L466"></a><tt class="py-lineno">466</tt>  <tt class="py-line"><tt class="py-docstring">    Sets the range of dates used for calculations. </tt> </tt>
<a name="L467"></a><tt class="py-lineno">467</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L468"></a><tt class="py-lineno">468</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L469"></a><tt class="py-lineno">469</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L470"></a><tt class="py-lineno">470</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L471"></a><tt class="py-lineno">471</tt>  <tt class="py-line"><tt class="py-docstring">    startDay </tt> </tt>
<a name="L472"></a><tt class="py-lineno">472</tt>  <tt class="py-line"><tt class="py-docstring">    The starting date for the calculation. This is a julian date, a number </tt> </tt>
<a name="L473"></a><tt class="py-lineno">473</tt>  <tt class="py-line"><tt class="py-docstring">    between 1 and 365. </tt> </tt>
<a name="L474"></a><tt class="py-lineno">474</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L475"></a><tt class="py-lineno">475</tt>  <tt class="py-line"><tt class="py-docstring">    stopDay </tt> </tt>
<a name="L476"></a><tt class="py-lineno">476</tt>  <tt class="py-line"><tt class="py-docstring">    The end date for the calculation. This is a julian date, a number </tt> </tt>
<a name="L477"></a><tt class="py-lineno">477</tt>  <tt class="py-line"><tt class="py-docstring">    between 1 and 365. </tt> </tt>
<a name="L478"></a><tt class="py-lineno">478</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L479"></a><tt class="py-lineno">479</tt>  <tt class="py-line"><tt class="py-docstring">    [incDay] </tt> </tt>
<a name="L480"></a><tt class="py-lineno">480</tt>  <tt class="py-line"><tt class="py-docstring">    An optional boolean parameter (0 or 1) that determines if the start and </tt> </tt>
<a name="L481"></a><tt class="py-lineno">481</tt>  <tt class="py-line"><tt class="py-docstring">    stop dates are inclusive of the date range.</tt> </tt>
<a name="L482"></a><tt class="py-lineno">482</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L483"></a><tt class="py-lineno">483</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L484"></a><tt class="py-lineno">484</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-40" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-40', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-41" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-41', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"set.calc.dates"</tt><tt class="py-op">,</tt>  </tt>
<a name="L485"></a><tt class="py-lineno">485</tt>  <tt class="py-line">                                                  <tt class="py-name">startDay</tt><tt class="py-op">,</tt> <tt class="py-name">stopDay</tt><tt class="py-op">,</tt> <tt class="py-name">incDay</tt><tt class="py-op">)</tt> </tt>
<a name="L486"></a><tt class="py-lineno">486</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-42" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-42', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L487"></a><tt class="py-lineno">487</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="get_precision"></a><div id="get_precision-def"><a name="L488"></a><tt class="py-lineno">488</tt> <a class="py-toggle" href="#" id="get_precision-toggle" onclick="return toggle('get_precision');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.calculation-module.html#get_precision">get_precision</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_precision-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="get_precision-expanded"><a name="L489"></a><tt class="py-lineno">489</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L490"></a><tt class="py-lineno">490</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L491"></a><tt class="py-lineno">491</tt>  <tt class="py-line"><tt class="py-docstring">    Retrieves the level of precision used in lighting calculations for the </tt> </tt>
<a name="L492"></a><tt class="py-lineno">492</tt>  <tt class="py-line"><tt class="py-docstring">    calc.lighting command. </tt> </tt>
<a name="L493"></a><tt class="py-lineno">493</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L494"></a><tt class="py-lineno">494</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L495"></a><tt class="py-lineno">495</tt>  <tt class="py-line"><tt class="py-docstring">    There are no parameters for this property.</tt> </tt>
<a name="L496"></a><tt class="py-lineno">496</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L497"></a><tt class="py-lineno">497</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L498"></a><tt class="py-lineno">498</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L499"></a><tt class="py-lineno">499</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L500"></a><tt class="py-lineno">500</tt>  <tt class="py-line"><tt class="py-docstring">    precision </tt> </tt>
<a name="L501"></a><tt class="py-lineno">501</tt>  <tt class="py-line"><tt class="py-docstring">    An integer value corresponding to one of the items in the following </tt> </tt>
<a name="L502"></a><tt class="py-lineno">502</tt>  <tt class="py-line"><tt class="py-docstring">    Calculation Precision table. </tt> </tt>
<a name="L503"></a><tt class="py-lineno">503</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L504"></a><tt class="py-lineno">504</tt>  <tt class="py-line"><tt class="py-docstring">    Relevant Data Table(s)</tt> </tt>
<a name="L505"></a><tt class="py-lineno">505</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L506"></a><tt class="py-lineno">506</tt>  <tt class="py-line"><tt class="py-docstring">    Available Calculation Precisions </tt> </tt>
<a name="L507"></a><tt class="py-lineno">507</tt>  <tt class="py-line"><tt class="py-docstring">    Token Value Description </tt> </tt>
<a name="L508"></a><tt class="py-lineno">508</tt>  <tt class="py-line"><tt class="py-docstring">    full 0 Full Precision </tt> </tt>
<a name="L509"></a><tt class="py-lineno">509</tt>  <tt class="py-line"><tt class="py-docstring">    veryhigh 1 Very High Precision </tt> </tt>
<a name="L510"></a><tt class="py-lineno">510</tt>  <tt class="py-line"><tt class="py-docstring">    high 2 High Precision </tt> </tt>
<a name="L511"></a><tt class="py-lineno">511</tt>  <tt class="py-line"><tt class="py-docstring">    medium 3 Medium Precision </tt> </tt>
<a name="L512"></a><tt class="py-lineno">512</tt>  <tt class="py-line"><tt class="py-docstring">    low 4 Low Precision </tt> </tt>
<a name="L513"></a><tt class="py-lineno">513</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L514"></a><tt class="py-lineno">514</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L515"></a><tt class="py-lineno">515</tt>  <tt class="py-line">    <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-43" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-43', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-string">"get.calc.precision"</tt><tt class="py-op">)</tt> </tt>
<a name="L516"></a><tt class="py-lineno">516</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-44" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-44', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-45" class="py-name" targets="Function py2ecotect._util._convert_str_to_type()=py2ecotect._util-module.html#_convert_str_to_type"><a title="py2ecotect._util._convert_str_to_type" class="py-name" href="#" onclick="return doclink('link-45', '_convert_str_to_type', 'link-45');">_convert_str_to_type</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">int</tt><tt class="py-op">)</tt> </tt>
</div><a name="L517"></a><tt class="py-lineno">517</tt>  <tt class="py-line">     </tt>
<a name="set_precision"></a><div id="set_precision-def"><a name="L518"></a><tt class="py-lineno">518</tt> <a class="py-toggle" href="#" id="set_precision-toggle" onclick="return toggle('set_precision');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.calculation-module.html#set_precision">set_precision</a><tt class="py-op">(</tt><tt class="py-param">precision</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="set_precision-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="set_precision-expanded"><a name="L519"></a><tt class="py-lineno">519</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L520"></a><tt class="py-lineno">520</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L521"></a><tt class="py-lineno">521</tt>  <tt class="py-line"><tt class="py-docstring">    Sets the precision of lighting calculations to be used with the calc.</tt> </tt>
<a name="L522"></a><tt class="py-lineno">522</tt>  <tt class="py-line"><tt class="py-docstring">    lighting command. </tt> </tt>
<a name="L523"></a><tt class="py-lineno">523</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L524"></a><tt class="py-lineno">524</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L525"></a><tt class="py-lineno">525</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L526"></a><tt class="py-lineno">526</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L527"></a><tt class="py-lineno">527</tt>  <tt class="py-line"><tt class="py-docstring">    precision </tt> </tt>
<a name="L528"></a><tt class="py-lineno">528</tt>  <tt class="py-line"><tt class="py-docstring">    Determines the calculation accuracy by controlling the number of test </tt> </tt>
<a name="L529"></a><tt class="py-lineno">529</tt>  <tt class="py-line"><tt class="py-docstring">    rays sprayed from each test point, according to the following table. </tt> </tt>
<a name="L530"></a><tt class="py-lineno">530</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L531"></a><tt class="py-lineno">531</tt>  <tt class="py-line"><tt class="py-docstring">    Relevant Data Table(s)</tt> </tt>
<a name="L532"></a><tt class="py-lineno">532</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L533"></a><tt class="py-lineno">533</tt>  <tt class="py-line"><tt class="py-docstring">    Available Calculation Precisions </tt> </tt>
<a name="L534"></a><tt class="py-lineno">534</tt>  <tt class="py-line"><tt class="py-docstring">    Token Value Description </tt> </tt>
<a name="L535"></a><tt class="py-lineno">535</tt>  <tt class="py-line"><tt class="py-docstring">    full 0 Full Precision </tt> </tt>
<a name="L536"></a><tt class="py-lineno">536</tt>  <tt class="py-line"><tt class="py-docstring">    veryhigh 1 Very High Precision </tt> </tt>
<a name="L537"></a><tt class="py-lineno">537</tt>  <tt class="py-line"><tt class="py-docstring">    high 2 High Precision </tt> </tt>
<a name="L538"></a><tt class="py-lineno">538</tt>  <tt class="py-line"><tt class="py-docstring">    medium 3 Medium Precision </tt> </tt>
<a name="L539"></a><tt class="py-lineno">539</tt>  <tt class="py-line"><tt class="py-docstring">    low 4 Low Precision </tt> </tt>
<a name="L540"></a><tt class="py-lineno">540</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L541"></a><tt class="py-lineno">541</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L542"></a><tt class="py-lineno">542</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-46" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-46', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-47" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-47', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"set.calc.precision"</tt><tt class="py-op">,</tt>  </tt>
<a name="L543"></a><tt class="py-lineno">543</tt>  <tt class="py-line">                                                  <tt id="link-48" class="py-name" targets="Variable py2ecotect.doc.rays.Rays.precision=py2ecotect.doc.rays.Rays-class.html#precision"><a title="py2ecotect.doc.rays.Rays.precision" class="py-name" href="#" onclick="return doclink('link-48', 'precision', 'link-48');">precision</a></tt><tt class="py-op">)</tt> </tt>
<a name="L544"></a><tt class="py-lineno">544</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-49" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-49', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L545"></a><tt class="py-lineno">545</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="get_sky"></a><div id="get_sky-def"><a name="L546"></a><tt class="py-lineno">546</tt> <a class="py-toggle" href="#" id="get_sky-toggle" onclick="return toggle('get_sky');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.calculation-module.html#get_sky">get_sky</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_sky-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="get_sky-expanded"><a name="L547"></a><tt class="py-lineno">547</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L548"></a><tt class="py-lineno">548</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L549"></a><tt class="py-lineno">549</tt>  <tt class="py-line"><tt class="py-docstring">    Retrieves the type of sky illuminance distribution and design sky </tt> </tt>
<a name="L550"></a><tt class="py-lineno">550</tt>  <tt class="py-line"><tt class="py-docstring">    illuminance level used during daylight calculations. </tt> </tt>
<a name="L551"></a><tt class="py-lineno">551</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L552"></a><tt class="py-lineno">552</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L553"></a><tt class="py-lineno">553</tt>  <tt class="py-line"><tt class="py-docstring">    There are no parameters for this property.</tt> </tt>
<a name="L554"></a><tt class="py-lineno">554</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L555"></a><tt class="py-lineno">555</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L556"></a><tt class="py-lineno">556</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L557"></a><tt class="py-lineno">557</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L558"></a><tt class="py-lineno">558</tt>  <tt class="py-line"><tt class="py-docstring">    sky </tt> </tt>
<a name="L559"></a><tt class="py-lineno">559</tt>  <tt class="py-line"><tt class="py-docstring">    An integer value or token taken from the following Sky Types table. </tt> </tt>
<a name="L560"></a><tt class="py-lineno">560</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L561"></a><tt class="py-lineno">561</tt>  <tt class="py-line"><tt class="py-docstring">    level </tt> </tt>
<a name="L562"></a><tt class="py-lineno">562</tt>  <tt class="py-line"><tt class="py-docstring">    The design sky illuminance level in Lux. </tt> </tt>
<a name="L563"></a><tt class="py-lineno">563</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L564"></a><tt class="py-lineno">564</tt>  <tt class="py-line"><tt class="py-docstring">    Relevant Data Table(s)</tt> </tt>
<a name="L565"></a><tt class="py-lineno">565</tt>  <tt class="py-line"><tt class="py-docstring">    Available Sky Types </tt> </tt>
<a name="L566"></a><tt class="py-lineno">566</tt>  <tt class="py-line"><tt class="py-docstring">    Token Value Description </tt> </tt>
<a name="L567"></a><tt class="py-lineno">567</tt>  <tt class="py-line"><tt class="py-docstring">    overcast 0 CIE Overcast Sky </tt> </tt>
<a name="L568"></a><tt class="py-lineno">568</tt>  <tt class="py-line"><tt class="py-docstring">    uniform 1 CIE Uniform Sky </tt> </tt>
<a name="L569"></a><tt class="py-lineno">569</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L570"></a><tt class="py-lineno">570</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L571"></a><tt class="py-lineno">571</tt>  <tt class="py-line">    <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-50" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-50', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-string">"get.calc.sky"</tt><tt class="py-op">)</tt> </tt>
<a name="L572"></a><tt class="py-lineno">572</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-51" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-51', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-52" class="py-name"><a title="py2ecotect._util._convert_str_to_list" class="py-name" href="#" onclick="return doclink('link-52', '_convert_str_to_list', 'link-39');">_convert_str_to_list</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">int</tt><tt class="py-op">)</tt> </tt>
</div><a name="L573"></a><tt class="py-lineno">573</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="set_material_default"></a><div id="set_material_default-def"><a name="L574"></a><tt class="py-lineno">574</tt> <a class="py-toggle" href="#" id="set_material_default-toggle" onclick="return toggle('set_material_default');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.calculation-module.html#set_material_default">set_material_default</a><tt class="py-op">(</tt><tt class="py-param">sky</tt><tt class="py-op">,</tt> <tt class="py-param">level</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="set_material_default-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="set_material_default-expanded"><a name="L575"></a><tt class="py-lineno">575</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L576"></a><tt class="py-lineno">576</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L577"></a><tt class="py-lineno">577</tt>  <tt class="py-line"><tt class="py-docstring">    Set this property to make the specified material the default for all new </tt> </tt>
<a name="L578"></a><tt class="py-lineno">578</tt>  <tt class="py-line"><tt class="py-docstring">    objects of the same element type. </tt> </tt>
<a name="L579"></a><tt class="py-lineno">579</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L580"></a><tt class="py-lineno">580</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L581"></a><tt class="py-lineno">581</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L582"></a><tt class="py-lineno">582</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L583"></a><tt class="py-lineno">583</tt>  <tt class="py-line"><tt class="py-docstring">    sky </tt> </tt>
<a name="L584"></a><tt class="py-lineno">584</tt>  <tt class="py-line"><tt class="py-docstring">    An integer value or token taken from the following Sky Types table. </tt> </tt>
<a name="L585"></a><tt class="py-lineno">585</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L586"></a><tt class="py-lineno">586</tt>  <tt class="py-line"><tt class="py-docstring">    level </tt> </tt>
<a name="L587"></a><tt class="py-lineno">587</tt>  <tt class="py-line"><tt class="py-docstring">    The design sky illuminance level in Lux. </tt> </tt>
<a name="L588"></a><tt class="py-lineno">588</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L589"></a><tt class="py-lineno">589</tt>  <tt class="py-line"><tt class="py-docstring">    Relevant Data Table(s)</tt> </tt>
<a name="L590"></a><tt class="py-lineno">590</tt>  <tt class="py-line"><tt class="py-docstring">    Available Sky Types </tt> </tt>
<a name="L591"></a><tt class="py-lineno">591</tt>  <tt class="py-line"><tt class="py-docstring">    Token Value Description </tt> </tt>
<a name="L592"></a><tt class="py-lineno">592</tt>  <tt class="py-line"><tt class="py-docstring">    overcast 0 CIE Overcast Sky </tt> </tt>
<a name="L593"></a><tt class="py-lineno">593</tt>  <tt class="py-line"><tt class="py-docstring">    uniform 1 CIE Uniform Sky </tt> </tt>
<a name="L594"></a><tt class="py-lineno">594</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L595"></a><tt class="py-lineno">595</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L596"></a><tt class="py-lineno">596</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-53" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-53', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-54" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-54', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"set.material.default"</tt><tt class="py-op">,</tt>  </tt>
<a name="L597"></a><tt class="py-lineno">597</tt>  <tt class="py-line">                                                  <tt id="link-55" class="py-name" targets="Variable py2ecotect.app.radiance.Radiance.sky=py2ecotect.app.radiance.Radiance-class.html#sky"><a title="py2ecotect.app.radiance.Radiance.sky" class="py-name" href="#" onclick="return doclink('link-55', 'sky', 'link-55');">sky</a></tt><tt class="py-op">,</tt> <tt class="py-name">level</tt><tt class="py-op">)</tt> </tt>
<a name="L598"></a><tt class="py-lineno">598</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-56" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-56', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L599"></a><tt class="py-lineno">599</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="get_times"></a><div id="get_times-def"><a name="L600"></a><tt class="py-lineno">600</tt> <a class="py-toggle" href="#" id="get_times-toggle" onclick="return toggle('get_times');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.calculation-module.html#get_times">get_times</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_times-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="get_times-expanded"><a name="L601"></a><tt class="py-lineno">601</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L602"></a><tt class="py-lineno">602</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L603"></a><tt class="py-lineno">603</tt>  <tt class="py-line"><tt class="py-docstring">    Retrieves the range of times used for calculations. Up to three values </tt> </tt>
<a name="L604"></a><tt class="py-lineno">604</tt>  <tt class="py-line"><tt class="py-docstring">    are returned, being the startTime, the stopTime, and the optional </tt> </tt>
<a name="L605"></a><tt class="py-lineno">605</tt>  <tt class="py-line"><tt class="py-docstring">    [incTime], which determines if the start and stop times are inclusive of </tt> </tt>
<a name="L606"></a><tt class="py-lineno">606</tt>  <tt class="py-line"><tt class="py-docstring">    the time range. </tt> </tt>
<a name="L607"></a><tt class="py-lineno">607</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L608"></a><tt class="py-lineno">608</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L609"></a><tt class="py-lineno">609</tt>  <tt class="py-line"><tt class="py-docstring">    There are no parameters for this property.</tt> </tt>
<a name="L610"></a><tt class="py-lineno">610</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L611"></a><tt class="py-lineno">611</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L612"></a><tt class="py-lineno">612</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L613"></a><tt class="py-lineno">613</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L614"></a><tt class="py-lineno">614</tt>  <tt class="py-line"><tt class="py-docstring">    startTime </tt> </tt>
<a name="L615"></a><tt class="py-lineno">615</tt>  <tt class="py-line"><tt class="py-docstring">    The starting time for the calculation. This is a decimal value between </tt> </tt>
<a name="L616"></a><tt class="py-lineno">616</tt>  <tt class="py-line"><tt class="py-docstring">    0.00 and 23.99. </tt> </tt>
<a name="L617"></a><tt class="py-lineno">617</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L618"></a><tt class="py-lineno">618</tt>  <tt class="py-line"><tt class="py-docstring">    stopTime </tt> </tt>
<a name="L619"></a><tt class="py-lineno">619</tt>  <tt class="py-line"><tt class="py-docstring">    The end time for the calculation. This is a decimal value between 0.00 </tt> </tt>
<a name="L620"></a><tt class="py-lineno">620</tt>  <tt class="py-line"><tt class="py-docstring">    and  23.99. </tt> </tt>
<a name="L621"></a><tt class="py-lineno">621</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L622"></a><tt class="py-lineno">622</tt>  <tt class="py-line"><tt class="py-docstring">    [incDay] </tt> </tt>
<a name="L623"></a><tt class="py-lineno">623</tt>  <tt class="py-line"><tt class="py-docstring">    A boolean value (0 or 1) indicating if the start and stop times are </tt> </tt>
<a name="L624"></a><tt class="py-lineno">624</tt>  <tt class="py-line"><tt class="py-docstring">    inclusive of the date range.</tt> </tt>
<a name="L625"></a><tt class="py-lineno">625</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L626"></a><tt class="py-lineno">626</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L627"></a><tt class="py-lineno">627</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L628"></a><tt class="py-lineno">628</tt>  <tt class="py-line">    <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-57" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-57', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-string">"get.calc.times"</tt><tt class="py-op">)</tt> </tt>
<a name="L629"></a><tt class="py-lineno">629</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-58" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-58', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-59" class="py-name"><a title="py2ecotect._util._convert_str_to_list" class="py-name" href="#" onclick="return doclink('link-59', '_convert_str_to_list', 'link-39');">_convert_str_to_list</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">float</tt><tt class="py-op">,</tt> <tt class="py-name">float</tt><tt class="py-op">,</tt> <tt class="py-name">bool</tt><tt class="py-op">)</tt> </tt>
</div><a name="L630"></a><tt class="py-lineno">630</tt>  <tt class="py-line"> </tt>
<a name="set_times"></a><div id="set_times-def"><a name="L631"></a><tt class="py-lineno">631</tt> <a class="py-toggle" href="#" id="set_times-toggle" onclick="return toggle('set_times');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.calculation-module.html#set_times">set_times</a><tt class="py-op">(</tt><tt class="py-param">startDay</tt><tt class="py-op">,</tt> <tt class="py-param">stopDay</tt><tt class="py-op">,</tt> <tt class="py-param">incDay</tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="set_times-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="set_times-expanded"><a name="L632"></a><tt class="py-lineno">632</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L633"></a><tt class="py-lineno">633</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L634"></a><tt class="py-lineno">634</tt>  <tt class="py-line"><tt class="py-docstring">    Sets the range of times used for calculations. </tt> </tt>
<a name="L635"></a><tt class="py-lineno">635</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L636"></a><tt class="py-lineno">636</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L637"></a><tt class="py-lineno">637</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L638"></a><tt class="py-lineno">638</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L639"></a><tt class="py-lineno">639</tt>  <tt class="py-line"><tt class="py-docstring">    startTime </tt> </tt>
<a name="L640"></a><tt class="py-lineno">640</tt>  <tt class="py-line"><tt class="py-docstring">    Determines the starting time for the calculation. This is a decimal </tt> </tt>
<a name="L641"></a><tt class="py-lineno">641</tt>  <tt class="py-line"><tt class="py-docstring">    value between 0.00 and 23.99. </tt> </tt>
<a name="L642"></a><tt class="py-lineno">642</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L643"></a><tt class="py-lineno">643</tt>  <tt class="py-line"><tt class="py-docstring">    stopTime </tt> </tt>
<a name="L644"></a><tt class="py-lineno">644</tt>  <tt class="py-line"><tt class="py-docstring">    Determines the end time for the calculation. This is a decimal value </tt> </tt>
<a name="L645"></a><tt class="py-lineno">645</tt>  <tt class="py-line"><tt class="py-docstring">    between 0.00 and 23.99. </tt> </tt>
<a name="L646"></a><tt class="py-lineno">646</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L647"></a><tt class="py-lineno">647</tt>  <tt class="py-line"><tt class="py-docstring">    [incDay] </tt> </tt>
<a name="L648"></a><tt class="py-lineno">648</tt>  <tt class="py-line"><tt class="py-docstring">    An optional boolean parameter (0 or 1) that determines if the start and </tt> </tt>
<a name="L649"></a><tt class="py-lineno">649</tt>  <tt class="py-line"><tt class="py-docstring">    stop times are inclusive of the date range.</tt> </tt>
<a name="L650"></a><tt class="py-lineno">650</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L651"></a><tt class="py-lineno">651</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L652"></a><tt class="py-lineno">652</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-60" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-60', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-61" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-61', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"set.calc.times"</tt><tt class="py-op">,</tt>  </tt>
<a name="L653"></a><tt class="py-lineno">653</tt>  <tt class="py-line">                                                  <tt class="py-name">startDay</tt><tt class="py-op">,</tt> <tt class="py-name">stopDay</tt><tt class="py-op">,</tt> <tt class="py-name">incDay</tt><tt class="py-op">)</tt> </tt>
<a name="L654"></a><tt class="py-lineno">654</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-62" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-62', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L655"></a><tt class="py-lineno">655</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="get_window_cond"></a><div id="get_window_cond-def"><a name="L656"></a><tt class="py-lineno">656</tt> <a class="py-toggle" href="#" id="get_window_cond-toggle" onclick="return toggle('get_window_cond');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.calculation-module.html#get_window_cond">get_window_cond</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_window_cond-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="get_window_cond-expanded"><a name="L657"></a><tt class="py-lineno">657</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L658"></a><tt class="py-lineno">658</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L659"></a><tt class="py-lineno">659</tt>  <tt class="py-line"><tt class="py-docstring">    Gets the window conditions for lighting calculations using the </tt> </tt>
<a name="L660"></a><tt class="py-lineno">660</tt>  <tt class="py-line"><tt class="py-docstring">    calc.lighting command. </tt> </tt>
<a name="L661"></a><tt class="py-lineno">661</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L662"></a><tt class="py-lineno">662</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L663"></a><tt class="py-lineno">663</tt>  <tt class="py-line"><tt class="py-docstring">    There are no parameters for this property.</tt> </tt>
<a name="L664"></a><tt class="py-lineno">664</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L665"></a><tt class="py-lineno">665</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L666"></a><tt class="py-lineno">666</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L667"></a><tt class="py-lineno">667</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L668"></a><tt class="py-lineno">668</tt>  <tt class="py-line"><tt class="py-docstring">    cleanliness </tt> </tt>
<a name="L669"></a><tt class="py-lineno">669</tt>  <tt class="py-line"><tt class="py-docstring">    An index representing the average cleanliness of windows in the model, </tt> </tt>
<a name="L670"></a><tt class="py-lineno">670</tt>  <tt class="py-line"><tt class="py-docstring">    as given in the following table. </tt> </tt>
<a name="L671"></a><tt class="py-lineno">671</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L672"></a><tt class="py-lineno">672</tt>  <tt class="py-line"><tt class="py-docstring">    Relevant Data Table(s)</tt> </tt>
<a name="L673"></a><tt class="py-lineno">673</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L674"></a><tt class="py-lineno">674</tt>  <tt class="py-line"><tt class="py-docstring">    Window Cleanliness Values </tt> </tt>
<a name="L675"></a><tt class="py-lineno">675</tt>  <tt class="py-line"><tt class="py-docstring">    Value Description </tt> </tt>
<a name="L676"></a><tt class="py-lineno">676</tt>  <tt class="py-line"><tt class="py-docstring">    0 Clean Windows (x 1.00) </tt> </tt>
<a name="L677"></a><tt class="py-lineno">677</tt>  <tt class="py-line"><tt class="py-docstring">    1 Average Windows (x 0.90) </tt> </tt>
<a name="L678"></a><tt class="py-lineno">678</tt>  <tt class="py-line"><tt class="py-docstring">    2 Dirty Windows (x 0.75) </tt> </tt>
<a name="L679"></a><tt class="py-lineno">679</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L680"></a><tt class="py-lineno">680</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L681"></a><tt class="py-lineno">681</tt>  <tt class="py-line">    <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-63" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-63', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-string">"get.calc.windows"</tt><tt class="py-op">)</tt> </tt>
<a name="L682"></a><tt class="py-lineno">682</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-64" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-64', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-65" class="py-name"><a title="py2ecotect._util._convert_str_to_type" class="py-name" href="#" onclick="return doclink('link-65', '_convert_str_to_type', 'link-45');">_convert_str_to_type</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L683"></a><tt class="py-lineno">683</tt>  <tt class="py-line"> </tt>
<a name="set_window_cond"></a><div id="set_window_cond-def"><a name="L684"></a><tt class="py-lineno">684</tt> <a class="py-toggle" href="#" id="set_window_cond-toggle" onclick="return toggle('set_window_cond');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.doc.calculation-module.html#set_window_cond">set_window_cond</a><tt class="py-op">(</tt><tt class="py-param">cleanliness</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="set_window_cond-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="set_window_cond-expanded"><a name="L685"></a><tt class="py-lineno">685</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L686"></a><tt class="py-lineno">686</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L687"></a><tt class="py-lineno">687</tt>  <tt class="py-line"><tt class="py-docstring">    Sets the precision of lighting calculations to be used with the </tt> </tt>
<a name="L688"></a><tt class="py-lineno">688</tt>  <tt class="py-line"><tt class="py-docstring">    calc.lighting command. </tt> </tt>
<a name="L689"></a><tt class="py-lineno">689</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L690"></a><tt class="py-lineno">690</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L691"></a><tt class="py-lineno">691</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L692"></a><tt class="py-lineno">692</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L693"></a><tt class="py-lineno">693</tt>  <tt class="py-line"><tt class="py-docstring">    cleanliness </tt> </tt>
<a name="L694"></a><tt class="py-lineno">694</tt>  <tt class="py-line"><tt class="py-docstring">    An index representing the average cleanliness of windows in the model, </tt> </tt>
<a name="L695"></a><tt class="py-lineno">695</tt>  <tt class="py-line"><tt class="py-docstring">    as given in the following table. </tt> </tt>
<a name="L696"></a><tt class="py-lineno">696</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L697"></a><tt class="py-lineno">697</tt>  <tt class="py-line"><tt class="py-docstring">    Relevant Data Table(s)</tt> </tt>
<a name="L698"></a><tt class="py-lineno">698</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L699"></a><tt class="py-lineno">699</tt>  <tt class="py-line"><tt class="py-docstring">    Window Cleanliness Values </tt> </tt>
<a name="L700"></a><tt class="py-lineno">700</tt>  <tt class="py-line"><tt class="py-docstring">    Value Description </tt> </tt>
<a name="L701"></a><tt class="py-lineno">701</tt>  <tt class="py-line"><tt class="py-docstring">    0 Clean Windows (x 1.00) </tt> </tt>
<a name="L702"></a><tt class="py-lineno">702</tt>  <tt class="py-line"><tt class="py-docstring">    1 Average Windows (x 0.90) </tt> </tt>
<a name="L703"></a><tt class="py-lineno">703</tt>  <tt class="py-line"><tt class="py-docstring">    2 Dirty Windows (x 0.75) </tt> </tt>
<a name="L704"></a><tt class="py-lineno">704</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L705"></a><tt class="py-lineno">705</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L706"></a><tt class="py-lineno">706</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-66" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-66', '_util', 'link-1');">_util</a></tt><tt class="py-op">.</tt><tt id="link-67" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-67', '_convert_args_to_string', 'link-2');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"set.calc.windows"</tt><tt class="py-op">,</tt>  </tt>
<a name="L707"></a><tt class="py-lineno">707</tt>  <tt class="py-line">                                                  <tt class="py-name">cleanliness</tt><tt class="py-op">)</tt> </tt>
<a name="L708"></a><tt class="py-lineno">708</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-68" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-68', '_app', 'link-4');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
<a name="L709"></a><tt class="py-lineno">709</tt>  <tt class="py-line">     </tt>
<a name="L710"></a><tt class="py-lineno">710</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">property</tt><tt class="py-op">(</tt><tt class="py-op">**</tt><tt class="py-name">locals</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L711"></a><tt class="py-lineno">711</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------</tt> </tt>
<a name="L712"></a><tt class="py-lineno">712</tt>  <tt class="py-line"><tt class="py-comment"></tt> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Fri Aug 28 01:29:49 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
